Request a report result Schema
api_result Element
Request a report result Schema : api_result Element
Description
starts a results connection.
Namespace (none)
Diagram
result Element num_results Element authentication Element Sequence api_result Element
Overview
api_result
starts a results connection.
Sequence
authentication xs:string
Confirmation that the username and password has been accepted.
num_results xs:string
Defines the number of results in this report.
result
Defines the overall result summary for this report.
Sequence
location xs:string
where the job is located.  This will be either "pending", "transmit" or "received".
job_num xs:string
This is the number that the PRODOCOM production system uses to identify a specific job.  This will be an 8 digit alpha numeric field and is used to identify a particular job.  The_job num can also be used in the PRODOCOM web portal to locate a job in the reporting option.
date_gmt xs:string
The GMT (Greenwich Mean time) date of the report.
charge_code xs:string
An optional field that you can use to break up your jobs on the invoice from PRODOCOM.
reference xs:string
An optional field.  When used with emails, this is the subject line of the email.  Otherwise, can be used for client reporting purposes.
count xs:string
The number of destinations in this job.
failed xs:string
The number of failed destinations in this job.
success xs:string
The number of successful destinations in this job.
complete xs:string
The number of completed destinations in this job.
pages xs:string
The number of pages per destination in this job.
client_ref xs:string
This field is for your reference ID for the initial transfer request.
destination
Defines the details for each destination.  You may have many destination elements in one result depending on the job in question.  All fields are optional and will depend on the information provided.  Custom field data will only be sent back if requested using the <includecustom> field in the report request.
Sequence
recip_id xs:string
Your systems id number for the intended recipient.
dest_seq xs:string
The PRODOCOM production system ID for the intended recipient.
type xs:string
The delivery type for this message.
status xs:string
Confirms the current status for this destination.
lrs xs:string
lrs stands for last result sent.  This will report the exact result we recorded at our final delivery point.
pages_sent xs:string
The number of pages sent.
sent_date xs:string
The date and time the message was sent.
attention xs:string
Usually the first and last names of the intended recipient.
recipient xs:string
The intended recipients delivery address.  This could be a fax number, email address, phone number, Mobile App Id or the first line of their postal address.
efs xs:string
efs stands for email file size.  This confirms the actual size of an email sent.  It is worth noting that when in transmission emails tend to be up to 1.5 times bigger due to the mime encoding used for transporting emails.
seconds xs:string
The number of seconds it took to deliver a fax or voice message.
custom1 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom2 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom3 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom4 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom5 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom6 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom7 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom8 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom9 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom10 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom11 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom12 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom13 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom14 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom15 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom16 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom17 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom18 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom19 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom20 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom21 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom22 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom23 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom24 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom25 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom26 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom27 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom28 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom29 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom30 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom31 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom32 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom33 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom34 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom35 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom36 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom37 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom38 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom39 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom40 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom41 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom42 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom43 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom44 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom45 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom46 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom47 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom48 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom49 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom50 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom51 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom52 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom53 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom54 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom55 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom56 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom57 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom58 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom59 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom60 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom61 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom62 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom63 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom64 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom65 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom66 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom67 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom68 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom69 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom70 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom71 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom72 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom73 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom74 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom75 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom76 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom77 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom78 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom79 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom80 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom81 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom82 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom83 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom84 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom85 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom86 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom87 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom88 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
custom89 xs:string
A custom command that can be used for data that doesn't fit any other category.  This will only be returned if the <includecustom> command is included in the request for report.
download xs:string
A document Id that can be used to download a copy of the document sent.
Source
<xs:element name="api_result" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexType>
    <xs:sequence>
      <xs:element type="xs:string" name="authentication" />
      <xs:element type="xs:string" name="num_results" />
      <xs:element name="result">
        <xs:complexType>
          <xs:sequence>
            <xs:element type="xs:string" name="location" />
            <xs:element type="xs:string" name="job_num" />
            <xs:element type="xs:string" name="date_gmt" />
            <xs:element type="xs:string" name="charge_code" />
            <xs:element type="xs:string" name="reference" />
            <xs:element type="xs:string" name="count" />
            <xs:element type="xs:string" name="failed" />
            <xs:element type="xs:string" name="success" />
            <xs:element type="xs:string" name="complete" />
            <xs:element type="xs:string" name="pages" />
            <xs:element type="xs:string" name="client_ref" />
            <xs:element name="destination">
              <xs:complexType>
                <xs:sequence>
                  <xs:element type="xs:string" name="recip_id" />
                  <xs:element type="xs:string" name="dest_seq" />
                  <xs:element type="xs:string" name="type" />
                  <xs:element type="xs:string" name="status" />
                  <xs:element type="xs:string" name="lrs" />
                  <xs:element type="xs:string" name="pages_sent" />
                  <xs:element type="xs:string" name="sent_date" />
                  <xs:element type="xs:string" name="attention" />
                  <xs:element type="xs:string" name="recipient" />
                  <xs:element type="xs:string" name="efs" />
                  <xs:element type="xs:string" name="seconds" />
                  <xs:element type="xs:string" name="custom1" />
                  <xs:element type="xs:string" name="custom2" />
                  <xs:element type="xs:string" name="custom3" />
                  <xs:element type="xs:string" name="custom4" />
                  <xs:element type="xs:string" name="custom5" />
                  <xs:element type="xs:string" name="custom6" />
                  <xs:element type="xs:string" name="custom7" />
                  <xs:element type="xs:string" name="custom8" />
                  <xs:element type="xs:string" name="custom9" />
                  <xs:element type="xs:string" name="custom10" />
                  <xs:element type="xs:string" name="custom11" />
                  <xs:element type="xs:string" name="custom12" />
                  <xs:element type="xs:string" name="custom13" />
                  <xs:element type="xs:string" name="custom14" />
                  <xs:element type="xs:string" name="custom15" />
                  <xs:element type="xs:string" name="custom16" />
                  <xs:element type="xs:string" name="custom17" />
                  <xs:element type="xs:string" name="custom18" />
                  <xs:element type="xs:string" name="custom19" />
                  <xs:element type="xs:string" name="custom20" />
                  <xs:element type="xs:string" name="custom21" />
                  <xs:element type="xs:string" name="custom22" />
                  <xs:element type="xs:string" name="custom23" />
                  <xs:element type="xs:string" name="custom24" />
                  <xs:element type="xs:string" name="custom25" />
                  <xs:element type="xs:string" name="custom26" />
                  <xs:element type="xs:string" name="custom27" />
                  <xs:element type="xs:string" name="custom28" />
                  <xs:element type="xs:string" name="custom29" />
                  <xs:element type="xs:string" name="custom30" />
                  <xs:element type="xs:string" name="custom31" />
                  <xs:element type="xs:string" name="custom32" />
                  <xs:element type="xs:string" name="custom33" />
                  <xs:element type="xs:string" name="custom34" />
                  <xs:element type="xs:string" name="custom35" />
                  <xs:element type="xs:string" name="custom36" />
                  <xs:element type="xs:string" name="custom37" />
                  <xs:element type="xs:string" name="custom38" />
                  <xs:element type="xs:string" name="custom39" />
                  <xs:element type="xs:string" name="custom40" />
                  <xs:element type="xs:string" name="custom41" />
                  <xs:element type="xs:string" name="custom42" />
                  <xs:element type="xs:string" name="custom43" />
                  <xs:element type="xs:string" name="custom44" />
                  <xs:element type="xs:string" name="custom45" />
                  <xs:element type="xs:string" name="custom46" />
                  <xs:element type="xs:string" name="custom47" />
                  <xs:element type="xs:string" name="custom48" />
                  <xs:element type="xs:string" name="custom49" />
                  <xs:element type="xs:string" name="custom50" />
                  <xs:element type="xs:string" name="custom51" />
                  <xs:element type="xs:string" name="custom52" />
                  <xs:element type="xs:string" name="custom53" />
                  <xs:element type="xs:string" name="custom54" />
                  <xs:element type="xs:string" name="custom55" />
                  <xs:element type="xs:string" name="custom56" />
                  <xs:element type="xs:string" name="custom57" />
                  <xs:element type="xs:string" name="custom58" />
                  <xs:element type="xs:string" name="custom59" />
                  <xs:element type="xs:string" name="custom60" />
                  <xs:element type="xs:string" name="custom61" />
                  <xs:element type="xs:string" name="custom62" />
                  <xs:element type="xs:string" name="custom63" />
                  <xs:element type="xs:string" name="custom64" />
                  <xs:element type="xs:string" name="custom65" />
                  <xs:element type="xs:string" name="custom66" />
                  <xs:element type="xs:string" name="custom67" />
                  <xs:element type="xs:string" name="custom68" />
                  <xs:element type="xs:string" name="custom69" />
                  <xs:element type="xs:string" name="custom70" />
                  <xs:element type="xs:string" name="custom71" />
                  <xs:element type="xs:string" name="custom72" />
                  <xs:element type="xs:string" name="custom73" />
                  <xs:element type="xs:string" name="custom74" />
                  <xs:element type="xs:string" name="custom75" />
                  <xs:element type="xs:string" name="custom76" />
                  <xs:element type="xs:string" name="custom77" />
                  <xs:element type="xs:string" name="custom78" />
                  <xs:element type="xs:string" name="custom79" />
                  <xs:element type="xs:string" name="custom80" />
                  <xs:element type="xs:string" name="custom81" />
                  <xs:element type="xs:string" name="custom82" />
                  <xs:element type="xs:string" name="custom83" />
                  <xs:element type="xs:string" name="custom84" />
                  <xs:element type="xs:string" name="custom85" />
                  <xs:element type="xs:string" name="custom86" />
                  <xs:element type="xs:string" name="custom87" />
                  <xs:element type="xs:string" name="custom88" />
                  <xs:element type="xs:string" name="custom89" />
                  <xs:element type="xs:string" name="download" />
                </xs:sequence>
              </xs:complexType>
            </xs:element>
          </xs:sequence>
        </xs:complexType>
      </xs:element>
    </xs:sequence>
  </xs:complexType>
</xs:element>
See Also
Request a report result Schema

 

 

© 2013 All Rights Reserved.

Send comments on this topic.